home *** CD-ROM | disk | FTP | other *** search
/ The Utilities Experience / The Utilities Experience - Volume 1.iso / software / misc / e-n / hsc / src_docs / options.hsc < prev    next >
Text File  |  1995-10-09  |  4KB  |  96 lines
  1. <$INCLUDE FILE="inc/macro.hsc">
  2. <WEBPAGE chapter="hsc - " title="Options">
  3.  
  4. <* macro to format an explanation *>
  5. <$MACRO explan NAME:string>
  6. <DT><B><$INSERT TEXT=<name>></B>
  7. <DD>
  8. </$MACRO>
  9. <* macro to format an example *>
  10. <$MACRO example EXMP:string>
  11. <DT><TT><$INSERT TEXT=<exmp>></TT>
  12. <DD>
  13. </$MACRO>
  14.  
  15. All options and swiches are case-insensitive. If you start <hsc>
  16. without any options, a short help message will be displayed.<P>
  17.  
  18. <hsc> understands the following options:<P>
  19.  
  20. <DL>
  21. <EXPLAN NAME="Help">
  22.     Display a short help message.
  23. <EXPLAN NAME="[from=]<I>infile</I>">
  24.     Specifies the input filename. To use <TT>stdin</TT> as
  25.     input file, see PipeIn.
  26. <EXPLAN NAME="[to=]<I>outfile</I>">
  27.     Specifies the output filename. If no output file is given, <TT>stdout</TT>
  28.     is used instead.
  29. <EXPLAN NAME="DestDir=<I>destination_directory</I>">
  30.     Specifies the destination directory for output file.
  31. <EXPLAN NAME="Errfile=<I>errfile</I>">
  32.     Redirects error output to a file. By default, <TT>stderr</TT> ist used.
  33. <EXPLAN NAME="Ignore=IGN">
  34.     Ignore warning message number. Numeric, can occure multiple.
  35.     (eg <TT>IGN=21 IGN=18</TT>.)
  36.  
  37. </DL>
  38.  
  39. <H1>Switches</H1>
  40. <DL>
  41. <EXPLAN name="AbsUri">
  42.     Enable <A HREF="features/absuris.html">Absolute URIs</A>
  43. <EXPLAN NAME="CheckUri">
  44.     <A HREF="features/checkuri.html">Check existence</A> of local URIs
  45. <*<EXPLAN NAME="PipeIn">
  46.     Read input file from <TT>stdin</TT>*>
  47. <EXPLAN NAME="RplcEnt">
  48.     <A HREF="features/rplcent.html">Replace special charaters</A> with its entity (eg "ü"
  49.     becomes "&uuml").
  50. <EXPLAN NAME="SmartEnt">
  51.     Replace special charaters "&", "<", ">", "\"" (quote) with its entity
  52.     (<CODE>&amp;, &lt;, &gt; &quot;</CODE>) if they are
  53.     surrounded by white-spaces.
  54. <EXPLAN NAME="Status">
  55.     Display file and line number during conversion. Included files
  56.     are also displayed. After processing a file, the filename and
  57.     the total number of lines remain visible. (output goes to stderr.)
  58. <EXPLAN NAME="Verbose">
  59.     More verbose status output. Enables the Status-switch.
  60. </DL>
  61.  
  62. <H1>Examples</H1>
  63. <DL>
  64. <EXAMPLE exmp="hsc FROM hugo.html TO t:">
  65.     Simly performs a syntax check on <FILE>hugo.html</FILE> and writes
  66.     a dummy-output to the temporary directory.
  67. <EXAMPLE exmp="hsc hugo.html t: STATUS RPLCENT">
  68.     Same as above, but also displays a status message during conversion.
  69.     Additionally, all special characters like "Ü" or "ß" are
  70.     replaced by its entities ("<TT>&Uuml;</TT>" and
  71.     "<TT>&szlig;</TT>")
  72. <EXAMPLE exmp="hsc FROM people/hugo.hsc DESTDIR /pub_html STATUS ABSURI">
  73.     Process subfile <FILE>people/hugo.hsc</FILE>. The current directory is the
  74.     main directory of the project. The HTML-object is created in
  75.     <FILE>/pub_html/people/hugo.hsc</FILE>. All local URIs referenced within
  76.     <FILE>hugo.hsc</FILE> are interpreted as <A HREF="features/absuris.html">
  77.     absolut URIs</A> and are converted to relative path when written to
  78.     the HTML-object.
  79. <EXAMPLE exmp="hsc FROM people/hugo.hsc DESTDIR /pub_html STATUS ABSURI CHECKURI">
  80.     Same as above. Additionally, all URIs referenced are checked for existence.
  81.     If eg, <FILE>people/hugo.hsc</FILE> references to <FILE>prog/project/thing.hsc</FILE>,
  82.     the file <FILE>/pub_html/project/thing.html</FILE> must exist or an error will
  83.     occure.<BR>
  84.     <STRONG>Note</STRONG>: Also mind that the HSC-source ends with ".hsc", but
  85.     the HTML-object automatically gets the extension ".html". Therefor, all
  86.     references must end with ".html".
  87. </DL>
  88.  
  89. <P>
  90.  
  91. <MAIN>
  92. <PREV href="features/rplcent.html">
  93. <NEXT href="errors.html">
  94. </WEBPAGE>
  95.  
  96.